Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

modify terminated-pod-gc-threshold explanation (#15272) #17183

Merged
merged 2 commits into from
Nov 5, 2019
Merged

modify terminated-pod-gc-threshold explanation (#15272) #17183

merged 2 commits into from
Nov 5, 2019

Conversation

hase1128
Copy link
Contributor

I modify terminated-pod-gc-threshold explanation

detail information is here.
#15272

@k8s-ci-robot
Copy link
Contributor

Welcome @hase1128!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
  • Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Oct 25, 2019
@hase1128
Copy link
Contributor Author

/assign @kbhawkey

@netlify
Copy link

netlify bot commented Oct 25, 2019

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 959d99c

https://deploy-preview-17183--kubernetes-io-master-staging.netlify.com

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 25, 2019
@kbhawkey
Copy link
Contributor

Hello @hase1128 . Thanks for submitting this PR.
I am looking into the change. In the meantime, would it be possible to remove the issue number from the commit line?
Page preview:
https://deploy-preview-17183--kubernetes-io-master-staging.netlify.com/docs/concepts/workloads/pods/pod-lifecycle/

duration (determined by `terminated-pod-gc-threshold` in the master) will expire and be automatically destroyed.
this rule is that Pods will be automatically destroyed if the number of Pods
with a `phase` of Succeeded or Failed surpasses a configurable threshold
(determined by `terminated-pod-gc-threshold` in the master).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hase1128 , I like the new update -- here is a possible tweak, starting with line 279:
In general, Pods remain until a human or controller process explicitly removes them.
However, Pods will be automatically destroyed if the number of terminated Pods, with a phase of Succeeded or Failed, surpasses a configurable threshold (determined by terminated-pod-gc-threshold in the master).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My suggestion for the final sentence:

Above a configured number of terminated Pods (with a phase of `Succeeded`
or `Failed`), the control plane cleans up some terminated Pods. This avoids
a resource leak as Pods as created and terminated over time. The clean up
threshold is based on the setting of `terminated-pod-gc-threshold` in the
kube-controller-manager.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hase1128, do you think you could incorporate @sftim 's suggestion into your PR?
@sftim, your suggestion offers a bit more detail, though, the first sentence seems more complicated.
What about starting the sentence as:
The control plane cleans up terminated Pods (with a ...) when the number of ... exceeds the configured threshold.

Also did you mean,
This avoids a resource leak as Pods are created and terminated over time?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kbhawkey @sftim

I incorporate your comments. How about the following explanation?

In general, Pods remain until a human or controller process explicitly removes them.
The control plane cleans up terminated Pods (with a phase of `Succeeded` or
`Failed`), when the number of Pods exceeds the configured threshold
(determined by `terminated-pod-gc-threshold` in the kube-controller-manager).
This avoids a resource leak as Pods are created and terminated over time.

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me.

@kbhawkey
Copy link
Contributor

Thanks!
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 28, 2019
@hase1128
Copy link
Contributor Author

@kbhawkey
Thank you for the comment and lgtm label.
Would you also add approved label?
I think this PR can be merged.

@kbhawkey
Copy link
Contributor

/cc @bradtopol

@kbhawkey
Copy link
Contributor

kbhawkey commented Nov 1, 2019

/assign @bradtopol

Copy link
Contributor

@bradtopol bradtopol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great job

@bradtopol
Copy link
Contributor

/approve
/lgtm

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bradtopol

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 5, 2019
@k8s-ci-robot k8s-ci-robot merged commit 6b261c7 into kubernetes:master Nov 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants